Updated README.md #6182
Updated README.md #6182
Conversation
WalkthroughThe Changes
Possibly related PRs
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (5)
README.md (5)
5-5: Consider using a CDN-hosted static image URLThe current logo URL uses Next.js's image optimization route (
_next/image), which might not be ideal for a README file as it:
- Depends on the Next.js server being available
- May not work properly when viewed on GitHub or other platforms
Consider hosting the logo on a CDN or using a direct static image URL from your repository:
- <img src="https://plane.so/_next/image?url=%2F_next%2Fstatic%2Fmedia%2Fplane-logo-with-text.31443952.png&w=640&q=75" alt="Plane Logo" width="300"> + <img src="https://plane-marketing.s3.ap-south-1.amazonaws.com/plane-logo-with-text.png" alt="Plane Logo" width="300">
63-79: Maintain consistent punctuation in feature descriptionsSome feature descriptions end with periods while others don't. Let's maintain consistency:
- Simplify complex projects by dividing them into smaller, manageable modules. + Simplify complex projects by dividing them into smaller, manageable modules.
90-111: Add language specifications to code blocksFor better syntax highlighting and documentation consistency, specify the language for each code block:
- ``` + ```bash git clone https://github.com/makeplane/plane.git ```Apply this to all command blocks in the local development section.
🧰 Tools
🪛 Markdownlint (0.35.0)
91-91: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
95-95: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
99-99: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
103-103: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
111-111: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
204-204: Add alt text to contributor imageFor better accessibility, add descriptive alt text to the contributor image:
- <img src="https://contrib.rocks/image?repo=makeplane/plane" /> + <img src="https://contrib.rocks/image?repo=makeplane/plane" alt="Plane GitHub contributors" />🧰 Tools
🪛 Markdownlint (0.35.0)
204-204: null
Images should have alternate text (alt text)(MD045, no-alt-text)
176-178: Enhance writing style in community sectionConsider these style improvements for a more professional tone:
- Feel free to ask questions, report bugs, participate in discussions + We encourage you to ask questions, report bugs, participate in discussions🧰 Tools
🪛 LanguageTool
[style] ~177-~177: The phrase ‘feel free to’ is used quite frequently. Consider using a less frequent alternative to set your writing apart from others and make it sound more professional.
Context: ...UCT.md) in all our community channels. Feel free to ask questions, report bugs, participate...(FEEL_FREE_TO_STYLE_ME)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
README.md(3 hunks)
🧰 Additional context used
🪛 Markdownlint (0.35.0)
README.md
87-87: null
Multiple spaces after hash on atx style heading
(MD019, no-multiple-space-atx)
91-91: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
95-95: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
99-99: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
103-103: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
111-111: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
201-201: Punctuation: '.'
Trailing punctuation in heading
(MD026, no-trailing-punctuation)
184-184: null
Bare URL used
(MD034, no-bare-urls)
204-204: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
🪛 LanguageTool
README.md
[style] ~177-~177: The phrase ‘feel free to’ is used quite frequently. Consider using a less frequent alternative to set your writing apart from others and make it sound more professional.
Context: ...UCT.md) in all our community channels. Feel free to ask questions, report bugs, participate...
(FEEL_FREE_TO_STYLE_ME)
[style] ~192-~192: This expression usually appears with a “please” in front of it.
Context: ...or any other ecosystem integration and let us know...
(INSERT_PLEASE)
🔇 Additional comments (2)
README.md (2)
44-59: LGTM! Well-structured installation section
The installation section effectively presents both cloud and self-hosted options with clear documentation links and setup guidance.
180-209: LGTM! Comprehensive security and contribution guidelines
The section effectively covers security reporting, contribution guidelines, and licensing information.
🧰 Tools
🪛 LanguageTool
[style] ~192-~192: This expression usually appears with a “please” in front of it.
Context: ...or any other ecosystem integration and let us know...
(INSERT_PLEASE)
🪛 Markdownlint (0.35.0)
201-201: Punctuation: '.'
Trailing punctuation in heading
(MD026, no-trailing-punctuation)
184-184: null
Bare URL used
(MD034, no-bare-urls)
204-204: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (7)
README.md (7)
45-60: Consider adding version information to installation guides.While the installation section is well-structured, adding minimum version requirements for Docker and Kubernetes would help users prepare their environment better.
| Installation methods | Requirements | Docs link | | ------------------- | ------------ | --------- | -| Docker | | [](https://developers.plane.so/self-hosting/methods/docker-compose) | +| Docker | Docker Engine 20.10.0+ | [](https://developers.plane.so/self-hosting/methods/docker-compose) | -| Kubernetes | | [](https://developers.plane.so/self-hosting/methods/kubernetes) | +| Kubernetes | Kubernetes 1.19+ | [](https://developers.plane.so/self-hosting/methods/kubernetes) |
62-82: Make the "coming soon" feature more prominent.Consider using a different formatting style to make the Drive feature's status more noticeable:
-- **Drive** (_coming soon_): The drive helps you share documents... +### 🚧 Coming Soon +- **Drive**: The drive helps you share documents...
93-114: Add language specifiers to code blocks for better readability.The code blocks should specify their language for proper syntax highlighting:
- ``` + ```bash git clone https://github.com/makeplane/plane.git ``` - ``` + ```bash cd plane ``` - ``` + ```bash git checkout -b <feature-branch-name> ``` - ``` + ```bash ./setup.sh ``` - ``` + ```bash docker compose -f docker-compose-local.yml up -d ```🧰 Tools
🪛 Markdownlint (0.37.0)
94-94: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
98-98: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
102-102: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
106-106: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
114-114: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
120-123: Improve badge layout efficiency.Consider displaying the technology stack badges in a single line for better space utilization:
-[](https://nextjs.org/)<br/> -[](https://www.djangoproject.com/)<br/> -[](https://nodejs.org/en) +[](https://nextjs.org/) +[](https://www.djangoproject.com/) +[](https://nodejs.org/en)
216-216: Add alt text to contributor images for accessibility.The contributor image is missing alt text:
- <img src="https://contrib.rocks/image?repo=makeplane/plane" /> + <img src="https://contrib.rocks/image?repo=makeplane/plane" alt="Plane GitHub contributors" />🧰 Tools
🪛 Markdownlint (0.37.0)
216-216: null
Images should have alternate text (alt text)(MD045, no-alt-text)
189-190: Enhance the writing style in the community section.Consider rephrasing for a more professional tone:
-Feel free to ask questions, report bugs, participate in discussions, share ideas, request features, or showcase your projects. +We welcome your questions, bug reports, discussion participation, ideas, feature requests, and project showcases.🧰 Tools
🪛 LanguageTool
[style] ~189-~189: The phrase ‘feel free to’ is used quite frequently. Consider using a less frequent alternative to set your writing apart from others and make it sound more professional.
Context: ...UCT.md) in all our community channels. Feel free to ask questions, report bugs, participate...(FEEL_FREE_TO_STYLE_ME)
196-196: Encode the security email address to prevent scraping.Consider encoding the email address to reduce spam:
-To disclose any security issues, please email us at [email protected]. +To disclose any security issues, please email us at <a href="mailto:security@plane.so">security[at]plane.so</a>.🧰 Tools
🪛 Markdownlint (0.37.0)
196-196: null
Bare URL used(MD034, no-bare-urls)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(4 hunks)
🧰 Additional context used
🪛 Markdownlint (0.37.0)
README.md
90-90: null
Multiple spaces after hash on atx style heading
(MD019, no-multiple-space-atx)
94-94: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
98-98: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
102-102: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
106-106: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
114-114: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
213-213: Punctuation: '.'
Trailing punctuation in heading
(MD026, no-trailing-punctuation)
196-196: null
Bare URL used
(MD034, no-bare-urls)
216-216: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
🪛 LanguageTool
README.md
[style] ~189-~189: The phrase ‘feel free to’ is used quite frequently. Consider using a less frequent alternative to set your writing apart from others and make it sound more professional.
Context: ...UCT.md) in all our community channels. Feel free to ask questions, report bugs, participate...
(FEEL_FREE_TO_STYLE_ME)
[style] ~204-~204: This expression usually appears with a “please” in front of it.
Context: ...or any other ecosystem integration and let us know...
(INSERT_PLEASE)
🔇 Additional comments (1)
README.md (1)
Line range hint 8-24: LGTM! Header section is well-structured.
The header section improvements, including the h1 title and comprehensive badges, enhance visibility and provide quick access to important resources.
Summary by CodeRabbit
Summary by CodeRabbit
README.md.